Run an Existing Schedule

{ runSchedule }

Launch and run an existing schedule

Method

/API/operations/runSchedule

  • API Section: /API/operations
  • API Version: 1.0
  • Method operates via POST actions only.

    • NOTE: API 1.0 methods are now deprecated. Use API 2.0 methods instead

    Input Parameters

    Name

    ExecuteScheduleApiData

    Object Type

    ExecuteScheduleApiData

    Description

    An object for settings the execution parameters of a schedule.

    Output Response

    Successful Result Code

    200

    Description of Response Type

    successful operation

    Notes

    This effectively runs the schedule immediately, creating a job to execute on the server. This includes both Publish and Model schedules